QuickOPC User's Guide and Reference
ObtainNewCertificateAsync(IEasyUAApplication,UAEndpointDescriptor,UAObtainNewCertificateParameters,IProgress<String[]>) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAApplicationExtension Class > ObtainNewCertificateAsync Method : ObtainNewCertificateAsync(IEasyUAApplication,UAEndpointDescriptor,UAObtainNewCertificateParameters,IProgress<String[]>) Method
The OPC UA client application object that will perform the operation.
The GDS endpoint acting as OPC UA certificate manager (CM).
The parameters describing how the certificate should be obtained.
A provider for progress updates.
Asynchronously obtains a new application instance certificate from the certificate manager, and stores it for subsequent usage.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ObtainNewCertificateAsync( _
   ByVal application As IEasyUAApplication, _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal parameters As UAObtainNewCertificateParameters, _
   ByVal progress As IProgress(Of String()) _
) As Task(Of IPkiCertificate)
'Usage
 
Dim application As IEasyUAApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim parameters As UAObtainNewCertificateParameters
Dim progress As IProgress(Of String())
Dim value As Task(Of IPkiCertificate)
 
value = IEasyUAApplicationExtension.ObtainNewCertificateAsync(application, gdsEndpointDescriptor, parameters, progress)

Parameters

application
The OPC UA client application object that will perform the operation.
gdsEndpointDescriptor
The GDS endpoint acting as OPC UA certificate manager (CM).
parameters
The parameters describing how the certificate should be obtained.
progress
A provider for progress updates.

Return Value

Returns a task that represents the asynchronous operation. The value of the TResult contains the certificate obtained from the certificate manager.
Exceptions
ExceptionDescription
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
Remarks

The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).

For a synchronous alternative, see the ObtainNewCertificate(IEasyUAApplication,UAEndpointDescriptor) extension method and its overloads.

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificate method and related extension methods.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2012 R2, Windows Server 2016; .NET Core, .NET 6: Linux, macOS, Microsoft Windows

See Also